home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / perl5 / 5.8.7 / File / Path.pm < prev    next >
Text File  |  2006-04-25  |  8KB  |  311 lines
  1. package File::Path;
  2.  
  3. =head1 NAME
  4.  
  5. File::Path - create or remove directory trees
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.     use File::Path;
  10.  
  11.     mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
  12.     rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);
  13.  
  14. =head1 DESCRIPTION
  15.  
  16. The C<mkpath> function provides a convenient way to create directories, even
  17. if your C<mkdir> kernel call won't create more than one level of directory at
  18. a time.  C<mkpath> takes three arguments:
  19.  
  20. =over 4
  21.  
  22. =item *
  23.  
  24. the name of the path to create, or a reference
  25. to a list of paths to create,
  26.  
  27. =item *
  28.  
  29. a boolean value, which if FALSE (the default for non-root users) will
  30. cause C<rmtree> to adjust the mode of directories (if required) prior
  31. to attempting to remove the contents.  Note that on interruption or
  32. failure of C<rmtree>, directories may be left with more permissi
  33. modes for the owner.
  34.  
  35. =item *
  36.  
  37. the numeric mode to use when creating the directories
  38. (defaults to 0777), to be modified by the current umask.
  39.  
  40. =back
  41.  
  42. It returns a list of all directories (including intermediates, determined
  43. using the Unix '/' separator) created.
  44.  
  45. If a system error prevents a directory from being created, then the
  46. C<mkpath> function throws a fatal error with C<Carp::croak>. This error
  47. can be trapped with an C<eval> block:
  48.  
  49.   eval { mkpath($dir) };
  50.   if ($@) {
  51.     print "Couldn't create $dir: $@";
  52.   }
  53.  
  54. Similarly, the C<rmtree> function provides a convenient way to delete a
  55. subtree from the directory structure, much like the Unix command C<rm -r>.
  56. C<rmtree> takes three arguments:
  57.  
  58. =over 4
  59.  
  60. =item *
  61.  
  62. the root of the subtree to delete, or a reference to
  63. a list of roots.  All of the files and directories
  64. below each root, as well as the roots themselves,
  65. will be deleted.
  66.  
  67. =item *
  68.  
  69. a boolean value, which if TRUE will cause C<rmtree> to
  70. print a message each time it examines a file, giving the
  71. name of the file, and indicating whether it's using C<rmdir>
  72. or C<unlink> to remove it, or that it's skipping it.
  73. (defaults to FALSE)
  74.  
  75. =item *
  76.  
  77. a boolean value, which if TRUE will cause C<rmtree> to
  78. skip any files to which you do not have delete access
  79. (if running under VMS) or write access (if running
  80. under another OS).  This will change in the future when
  81. a criterion for 'delete permission' under OSs other
  82. than VMS is settled.  (defaults to FALSE)
  83.  
  84. =back
  85.  
  86. It returns the number of files successfully deleted.  Symlinks are
  87. simply deleted and not followed.
  88.  
  89. B<NOTE:> There are race conditions internal to the implementation of
  90. C<rmtree> making it unsafe to use on directory trees which may be
  91. altered or moved while C<rmtree> is running, and in particular on any
  92. directory trees with any path components or subdirectories potentially
  93. writable by untrusted users.
  94.  
  95. Additionally, if the third parameter is not TRUE and C<rmtree> is
  96. interrupted, it may leave files and directories with permissions altered
  97. to allow deletion (and older versions of this module would even set
  98. files and directories to world-read/writable!)
  99.  
  100. Note also that the occurrence of errors in C<rmtree> can be determined I<only>
  101. by trapping diagnostic messages using C<$SIG{__WARN__}>; it is not apparent
  102. from the return value.
  103.  
  104. =head1 DIAGNOSTICS
  105.  
  106. =over 4
  107.  
  108. =item *
  109.  
  110. On Windows, if C<mkpath> gives you the warning: B<No such file or
  111. directory>, this may mean that you've exceeded your filesystem's
  112. maximum path length.
  113.  
  114. =back
  115.  
  116. =head1 AUTHORS
  117.  
  118. Tim Bunce <F<Tim.Bunce@ig.co.uk>> and
  119. Charles Bailey <F<bailey@newman.upenn.edu>>
  120.  
  121. =cut
  122.  
  123. use 5.006;
  124. use Carp;
  125. use File::Basename ();
  126. use Exporter ();
  127. use strict;
  128. use warnings;
  129. use Cwd 'getcwd';
  130.  
  131. our $VERSION = "1.07";
  132. our @ISA = qw( Exporter );
  133. our @EXPORT = qw( mkpath rmtree );
  134.  
  135. my $Is_VMS = $^O eq 'VMS';
  136. my $Is_MacOS = $^O eq 'MacOS';
  137.  
  138. # These OSes complain if you want to remove a file that you have no
  139. # write permission to:
  140. my $force_writeable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32' ||
  141.                $^O eq 'amigaos' || $^O eq 'MacOS' || $^O eq 'epoc');
  142.  
  143. sub mkpath {
  144.     my($paths, $verbose, $mode) = @_;
  145.     # $paths   -- either a path string or ref to list of paths
  146.     # $verbose -- optional print "mkdir $path" for each directory created
  147.     # $mode    -- optional permissions, defaults to 0777
  148.     local($")=$Is_MacOS ? ":" : "/";
  149.     $mode = 0777 unless defined($mode);
  150.     $paths = [$paths] unless ref $paths;
  151.     my(@created,$path);
  152.     foreach $path (@$paths) {
  153.     $path .= '/' if $^O eq 'os2' and $path =~ /^\w:\z/s; # feature of CRT 
  154.     # Logic wants Unix paths, so go with the flow.
  155.     if ($Is_VMS) {
  156.         next if $path eq '/';
  157.         $path = VMS::Filespec::unixify($path);
  158.         if ($path =~ m:^(/[^/]+)/?\z:) {
  159.             $path = $1.'/000000';
  160.         }
  161.     }
  162.     next if -d $path;
  163.     my $parent = File::Basename::dirname($path);
  164.     unless (-d $parent or $path eq $parent) {
  165.         push(@created,mkpath($parent, $verbose, $mode));
  166.      }
  167.     print "mkdir $path\n" if $verbose;
  168.     unless (mkdir($path,$mode)) {
  169.         my $e = $!;
  170.         # allow for another process to have created it meanwhile
  171.         croak "mkdir $path: $e" unless -d $path;
  172.     }
  173.     push(@created, $path);
  174.     }
  175.     @created;
  176. }
  177.  
  178. sub _rmtree;
  179. sub _rmtree
  180. {
  181.  
  182.     my ($path, $prefix, $up, $up_dev, $up_ino, $verbose, $safe) = @_;
  183.  
  184.     my ($dev, $ino) = lstat $path or do {
  185.         carp "Can't stat $prefix$path ($!)" unless $!{ENOENT};
  186.     return 0;
  187.     };
  188.  
  189.     unless (-d _)
  190.     {
  191.     print "unlink $prefix$path\n" if $verbose;
  192.     unless (unlink $path)
  193.     {
  194.         carp "Can't remove file $prefix$path ($!)";
  195.         return 0;
  196.      }
  197.     return 1;
  198.     }
  199.  
  200.     unless (chdir $path)
  201.     {
  202.     carp "Can't chdir to $prefix$path ($!)";
  203.     return 0;
  204.     }
  205.  
  206.     # avoid a race condition where a directory may be replaced by a
  207.     # symlink between the lstat and the chdir
  208.     my ($new_dev, $new_ino, $perm) = stat '.';
  209.     unless ("$new_dev:$new_ino" eq "$dev:$ino")
  210.     {
  211.     croak "Directory $prefix$path changed before chdir, aborting";
  212.     }
  213.  
  214.     $perm &= 07777;
  215.     my $nperm = $perm | 0700;
  216.     unless ($safe or $nperm == $perm or chmod $nperm, '.')
  217.     {
  218.     carp "Can't make directory $prefix$path read+writeable ($!)";
  219.     $nperm = $perm;
  220.     }
  221.  
  222.     my $count = 0;
  223.     if (opendir my $dir, '.')
  224.     {
  225.     my $entry;
  226.     while (defined ($entry = readdir $dir))
  227.     {
  228.         next if $entry =~ /^\.\.?$/;
  229.         $entry =~ /^(.*)$/s; $entry = $1; # untaint
  230.         $count += _rmtree $entry, "$prefix$path/", '..', $dev, $ino,
  231.         $verbose, $safe;
  232.      }
  233.  
  234.     closedir $dir;
  235.     }
  236.  
  237.     # restore directory permissions if required (in case the rmdir
  238.     # below fails) now, while we're still in the directory and may do
  239.     # so without a race via '.'
  240.     unless ($nperm == $perm or chmod $perm, '.')
  241.     {
  242.     carp "Can't restore permissions on directory $prefix$path ($!)";
  243.     }
  244.  
  245.     # don't leave the caller in an unexpected directory
  246.     unless (chdir $up)
  247.     {
  248.     croak "Can't return to $up from $prefix$path ($!)";
  249.     }
  250.  
  251.     # ensure that a chdir ..  didn't take us somewhere other than
  252.     # where we expected (see CVE-2002-0435)
  253.     unless (($new_dev, $new_ino) = stat '.'
  254.     and "$new_dev:$new_ino" eq "$up_dev:$up_ino")
  255.     {
  256.     croak "Previous directory $up changed since entering $prefix$path";
  257.     }
  258.  
  259.     print "rmdir $prefix$path\n" if $verbose;
  260.     if (rmdir $path)
  261.     {
  262.     $count++;
  263.     }
  264.     else
  265.     {
  266.     carp "Can't remove directory $prefix$path ($!)";
  267.     }
  268.  
  269.     return $count;
  270. }
  271.  
  272. sub rmtree
  273. {
  274.     my ($p, $verbose, $safe) = @_;
  275.     $p = [] unless defined $p and length $p;
  276.     $p = [ $p ] unless ref $p;
  277.     my @paths = grep defined && length, @$p;
  278.  
  279.     # default to "unsafe" for non-root (will chmod dirs)
  280.     $safe = $> ? 0 : 1 unless defined $safe;
  281.  
  282.     unless (@paths)
  283.     {
  284.     carp "No root path(s) specified";
  285.     return;
  286.     }
  287.  
  288.     my $oldpwd = getcwd or do {
  289.     carp "Can't fetch initial working directory";
  290.     return;
  291.     };
  292.  
  293.     my ($dev, $ino) = stat '.' or do {
  294.     carp "Can't stat initial working directory";
  295.     return;
  296.     };
  297.  
  298.     # untaint
  299.     for ($oldpwd) { /^(.*)$/s; $_ = $1 }
  300.  
  301.     my $count = 0;
  302.     for my $path (@paths)
  303.     {
  304.     $count += _rmtree $path, '', $oldpwd, $dev, $ino, $verbose, $safe;
  305.     }
  306.  
  307.     $count;
  308. }
  309.  
  310. 1;
  311.